curl --request POST \
  --url https://{tenant_name}.{region}.techwolf.ai/employees/{external_id}/matching_job_families \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filters": [
    {
      "filter": "last_updated",
      "value": "2022-01-01",
      "operator": "lt"
    },
    {
      "filter": "custom_property_equal",
      "from_entity_property": "desired_wage",
      "to_entity_property": "wage"
    },
    {
      "filter": "custom_property",
      "property_name": "direct_manager",
      "property_value": "John Doe"
    },
    {
      "filter": "custom_property_is_in",
      "from_entity_property": "required_drivers_license",
      "to_entity_property": "drivers_licenses"
    },
    {
      "filter": "custom_property_is_in_list",
      "property_name": "drivers_license",
      "possible_values": [
        "C",
        "CE"
      ]
    },
    {
      "filter": "custom_property_contains",
      "from_entity_property": "shift_regime_codes",
      "to_entity_property": "desired_regime"
    },
    {
      "filter": "custom_property_list_overlap",
      "from_entity_property": "desired_industries",
      "to_entity_property": "industries"
    },
    {
      "filter": "custom_property_contains_element",
      "property_name": "industries",
      "property_value": "electronics"
    },
    {
      "filter": "external_id_is_in_list",
      "external_ids": [
        "c350500-eb84-42dc-a79f-5e7b1fe897b7",
        "b450500-eb84-42dc-a79f-5e7b1fe897c8"
      ]
    }
  ],
  "weights": [
    {
      "weight": "skills_match",
      "value": 1
    }
  ]
}'
{
  "results": [
    {
      "job_family_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
      "employee_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
      "score": 0.87657
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
external_id
string
required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100

Query Parameters

​
limit
integer
default:
10

The maximal number of results returned.

Required range: 1 < x < 100
​
offset
integer
default:
0

The rank offset for returned matches, return matches starting from rank offset up to rank offset+limit.

Required range: x > 0
​
response_format
enum<string>
default:
simple

If set to explained, the response will include an explanation of the match.

Available options:
simple,
explained
​
include
enum<string>[]

Additional entity attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes. When include entity is used, the response will include the name of the Job Family and Job Family Group. attributes. When include entity is used, the response will include the name of the Job Family and Job Family Group.

Available options:
entity,
custom_properties

Body

application/json

List of filters to be applied on the entities before matching

​
filters
object[]
required
​
weights
object[]
required

List of weights to be applied during matching. Currently, Skills match weight is the only supported weight for Job Family matching and is set to 1.0 by default.

Response

200
application/json
OK
​
results
object[]
required

List of match results.

Was this page helpful?